﻿
// ———————————————————————–
// <copyright file="Generator.cs" company="The MITRE Corporation">
//    Copyright (c) 2014 The MITRE Corporation. All rights reserved.
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//    http://www.apache.org/licenses/LICENSE-2.0
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.
// </copyright>
// ———————————————————————–
/////////////////////////////////////////////////////////////////////////////////////////////////
// Generator.cs:
//
// An abstract class to facilitate the generation of examples for testing.
//
// Project: NIEMCADTest
// Author:  Lizzie DeYoung - MITRE
/////////////////////////////////////////////////////////////////////////////////////////////////

// Copyright (c) 2014 The MITRE Corporation. All rights reserved.
//
// NOTICE
// This software was produced for the U. S. Government
// under Contract No. FA8721-09-C-0001, and is
// subject to the Rights in Noncommercial Computer Software
// and Noncommercial Computer Software Documentation Clause
// (DFARS) 252.227-7014 (JUN 1995)  
      

using System.Xml;

namespace NIEMCADTest
{
  /// <summary>
  /// Each generator inherits from the Generator.cs abstract class. The generator class has a base GetXML
  /// method that replaces the element name, namespace, and prefix with the appropriate values. 
  /// Additionally, it includes a helper GetTestObject method that generates a test object with the 
  /// appropriate XML and element name, namespace, and prefix values.
  /// </summary>
  public abstract class Generator
  {
    protected string elementNamespace;
    protected string elementName;
    protected string elementPrefix;

    protected virtual string GetXml(string xml)
    {
      string newXml = xml;
      newXml = newXml.Replace("$namespace$", elementNamespace);
      newXml = newXml.Replace("$name$", elementName);
      newXml = newXml.Replace("$prefix$", elementPrefix);

      return newXml;
    }

    protected TestObject GetTestObject(string xml)
    {
      XmlNode node = TestHelper.ReadXML(xml);

      TestObject testObject = new TestObject(elementNamespace, elementName, elementPrefix);
      testObject.Xml = node;

      return testObject;
    }
  }
}
